<?php
/**
 * Copyright (c) 2010, Federico Cargnelutti. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgment:
 *    This product includes software developed by Federico Cargnelutti.
 * 4. Neither the name of Federico Cargnelutti nor the names of its contributors 
 *    may be used to endorse or promote products derived from this software without 
 *    specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY FEDERICO CARGNELUTTI "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL FEDERICO CARGNELUTTI BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category    Zf
 * @package     Zf_Orm
 * @author      Federico Cargnelutti <fedecarg@gmail.com>
 * @copyright   Copyright (c) 2010 Federico Cargnelutti
 * @license     New BSD License
 * @version     $Id: $
 */

/**
 * @category    Zf
 * @package     Zf_Orm
 * @author      Federico Cargnelutti <fedecarg@gmail.com>
 * @copyright   Copyright (c) 2010 Federico Cargnelutti
 * @license     New BSD License
 * @version     $Id: $
 */
class Zf_Orm_ExpressionException extends Zf_Orm_Exception {}

abstract class Zf_Orm_Expression
{
    /**
     * @var string
     */
    protected $name ;
    
    /**
     * @var string
     */
    protected $format;
    
    /**
     * @var integer
     */
    protected $numberOfArguments;
    
    /**
     * @return string
     * @throws Zf_Orm_ExpressionException
     */
    public function getName()
    {
        if (!is_string($this->name)) {
            throw new Zf_Orm_ExpressionException('The property "name" has an invalid value type');
        }
        return $this->name;
    }

    /**
     * @return string
     * @throws Zf_Orm_ExpressionException
     */
    public function getFormat()
    {
        if (!is_string($this->format)) {
            throw new Zf_Orm_ExpressionException('The property "format" has an invalid value type');
        }
        return $this->format;
    }
    
    /**
     * @return integer
     * @throws Zf_Orm_ExpressionException
     */
    public function getNumberOfArguments()
    {
        if (!is_int($this->numberOfArguments)) {
            throw new Zf_Orm_ExpressionException('The property "numberOfArguments" has an invalid value type');
        }
        return $this->numberOfArguments;
    }
    
    /**
     * @return string
     */
    public function toString()
    {
        return $this->getName();
    }
}
